# エージェント集合操作（配置）

## random_put_agtset

指定されたエージェント集合を連続空間上にランダムに配置する。

**random_put_agtset**(agtset)

* **agtset** - 指定するエージェント集合

※連続空間でのみ使用可能。

```
# エージェント集合peopleを空間上にランダムに配置する
random_put_agtset(people)
```



## random_put_agtset_sqgrid

指定されたエージェント集合を格子空間上にランダムに配置する。

**random_put_agtset_sqgrid**(agtset, overlap=False, avoid=None)

* **agtset** - 指定するエージェント集合
* **overlap** - agtsetを配置する際、同じ座標に重なって配置することを許すかどうか（初期値はFalse）
* **avoid** - 重ならないエージェント集合。既にマップ上に配置されているエージェント集合を指定する。初期値はNoneで、このとき重ならないエージェント集合を指定しない。

```
# エージェント集合peopleを格子空間上にランダムに配置する（重なって配置しない）
random_put_agtset_sqgrid(people)

# エージェント集合peopleを空間上にランダムに配置する（重なって配置することを許す）
random_put_agtset_sqgrid(people, overlap=True)

# エージェント集合peopleを、既に配置されているエージェント集合residentsにも重ならないようランダムに配置する
random_put_agtset_sqgrid(people, avoid=residents)
```



<!--

| 関数名                 | random_put_agtset_hexgrid                                    |
| ---------------------- | ------------------------------------------------------------ |
| 引数                   | Agtset:エージェント集合(set)   avoid=None:重ならないエージェント集合型(AgtSet) |
| 戻り値                 |                                                              |
| 説明                   | 指定されたエージェント集合を格子上にランダムに配置する  avoid引数にエージェント集合型変数が指定されたときのみ、そのエージェント集合を避けて配置する。 |
| 使用例                 |                                                              |
| 例外処理               | 空間チェック：ArtisocCloudIllegalUseOfFunctionError   →エージェントの属する空間が連続空間・四角格子空間の場合エラーを返す      引数の型チェック：ArtisocCloudTypeError   →set内にAgtでないものが含まれていた場合もこれを返す      エージェントの種別チェック：ArtisocCloudNotSpaceAgtError   →set内に空間エージェントでないUniverse直下のAgt型を指定したときエラー      エージェントの空間チェック：ArtisocCloudDifferentSpaceAgtError   引数のset内に異なる空間にいるエージェントを指定したらエラー |
| 実装箇所               | generalfunction                                              |
| artisoc4で対応する関数 | RandomPutAgtSetCell                                          |
| artisoc4との差異       | 重ならないエージェント集合型の指定をmove_space関数と揃えた   （artisoc4では単に他のエージェントとの重なりを認めるかどうかのbooleanだった）  六角格子専用にした |
| 動作条件               | 六角格子空間  （連続空間・四角格子空間ではエラー）           |
| 備考                   |                                                              |

-->