-
Notifications
You must be signed in to change notification settings - Fork 14
/
AgentSet.js
336 lines (313 loc) · 11.1 KB
/
AgentSet.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
import AgentArray from './AgentArray.js'
/**
* A model's {@link Patches}, {@link Turtles}, {@link Links},
* are all subclasses of AgentSet.
*
* AgentSets are {@link AgentArray}s that are factories for their own Agents.
* That means you do *not* call `new Turtle()`, rather Turtles
* will create the Turtle instances, adding them to itself.
*
* Finally, a Breed is simply a subarray of Patches, Turtles, Links.
* Patches could have a Streets breed, Turtles could have Cops and Robbers
* breeds, and Links Spokes and Rim breeds
*
* AgentSets are not created directly by modelers.
* Instead, class {@link Model} creates them along with their Breeds.
* You can easily skip this initially, instead simply understand AgentSets
* are the basis for Patches, Turtles, Links & Breeds
*
* @param {Model} model Instance of Class Model to which I belong
* @param {Patch|Turtle|Link} AgentClass Class of items stored in this AgentSet
* @param {String} name Name of this AgentSet. Ex: Patches
* @param {Patches|Turtles|Links} [baseSet=null] If a Breed, it's parent AgentSet
*/
export default class AgentSet extends AgentArray {
// Inherited by Patches, Turtles, Links
model
name
baseSet
AgentClass
/**
* Magic to return AgentArrays rather than AgentSets
* [Symbol.species](https://goo.gl/Zsxwxd)
*
* @readonly
*/
static get [Symbol.species]() {
return AgentArray
}
constructor(model, AgentClass, name, baseSet = null) {
super() // create empty AgentArray
baseSet = baseSet || this // if not a breed, set baseSet to this
Object.assign(this, { model, name, baseSet, AgentClass })
// BaseSets know their breeds and keep the ID global
if (this.isBaseSet()) {
this.breeds = {} // will contain breedname: breed entries
this.ID = 0
// Breeds inherit frm their baseSet and add themselves to baseSet
} else {
Object.setPrototypeOf(this, Object.getPrototypeOf(baseSet))
this.baseSet.breeds[name] = this
}
// Keep a list of this set's variables; see `own` below
// REMIND: not really used. Remove? Create after setup()?
this.ownVariables = []
// Create a proto for our agents by having a defaults and instance layer
// this.AgentClass = AgentClass
this.agentProto = new AgentClass(this)
this.protoMixin(this.agentProto, AgentClass)
// }
}
/**
* Add common variables to an Agent being added to this AgentSet.
*
* Each Agent has it's AgentSet and the Model instance.
* It also has an id, set by the AgentSet's global ID.
*
* The Agent also has three methods added: setBreed, getBreed, isBreed.
*
* @param {Object} agentProto A new instance of the Agent being added
* @param {Patch|Turtle|Link} AgentClass It's Class
*/
protoMixin(agentProto, AgentClass) {
Object.assign(agentProto, {
agentSet: this,
model: this.model,
// world: this.world
})
agentProto[this.baseSet.name] = this.baseSet
// if (this.isBaseSet()) {
// Model.reset should not redefine these.
if (!AgentClass.prototype.setBreed) {
Object.assign(AgentClass.prototype, {
setBreed(breed) {
breed.setBreed(this)
},
getBreed() {
return this.agentSet
},
isBreed(breed) {
return this.agentSet === breed
},
})
Object.defineProperty(AgentClass.prototype, 'breed', {
get: function () {
return this.agentSet
},
})
}
}
/**
* Create a subarray of this AgentSet.
* Example: create a people breed of Turtles:
*
* `people = turtles.newBreed('people')`
*
* @param {String} name The name of the new breed AgentSet
* @returns {AgentSet} A subarray of me
*/
newBreed(name) {
return new AgentSet(this.model, this.AgentClass, name, this)
}
/**
* @returns {boolean} true if I am a baseSet subarray
*/
isBreedSet() {
return this.baseSet !== this
}
/**
* @returns {boolean} true if I am a Patches, Turtles or Links AgentSet
*/
isBaseSet() {
return this.baseSet === this
}
/**
* Return breeds in a subset of an AgentSet
*
* Ex: patches.inRect(5).withBreed(houses)
*
* @param {AgentSet} breed A breed AgentSet
* @returns {AgentArray}
*/
withBreed(breed) {
return this.filter(a => a.agentSet === breed)
}
// Abstract method used by subclasses to create and add their instances.
create() {
console.log(`AgentSet: Abstract method called: ${this}`)
}
/**
* @param {Object} o An Agent to be added to this AgentSet
* @returns {Object} The input Agent, bound to this AgentSet.
* @description
* Add an Agent to this AgentSet. Only used by factory methods.
* Adds the `id` property to Agent. Increment AgentSet `ID`.
*/
addAgent(o = undefined) {
// o only for breeds adding themselves to their baseSet
o = o || Object.create(this.agentProto) // REMIND: Simplify! Too slick.
if (this.isBreedSet()) {
this.baseSet.addAgent(o)
} else {
o.id = this.ID++
if (o.agentConstructor) o.agentConstructor()
}
this.push(o)
return o
}
/**
* Remove all Agents from this AgentSet using agent.die() for each agent.
*
*/
clear() {
// die() is an agent method. sets it's id to -1
while (!this.isEmpty()) this.last().die()
}
/**
* Remove an Agent from this AgentSet
*
* @param {Object} o The Agent to be removed
* @returns {AgentSet} This AgentSet with the Agent removed
*/
removeAgent(o) {
// Note removeAgent(agent) different than remove(agent) which
// simply removes the agent from it's array
if (o.id != -1) {
// Remove me from my baseSet
if (this.isBreedSet()) this.baseSet.remove(o, 'id')
// Remove me from my set.
this.remove(o, 'id')
}
return this
}
/**
* Set a default value shared by all Agents in this AgentSet
*
* @param {String} name The name of the shared value
* @param {any} value
* @returns {AgentSet} This AgentSet
*/
setDefault(name, value) {
this.agentProto[name] = value
return this
}
/**
* Return a default, shared value
*
* @param {String} name The name of the default
* @returns {any} The default value
*/
getDefault(name) {
return this.agentProto[name]
}
// Used when getter/setter's need to know if get/set default
// settingDefault(agent) {
// return agent.id == null
// }
// Declare variables of an agent class. May deprecate if not needed.
// `varnames` is a string of space separated names
// own(varnames) {
// // if (this.isBreedSet())
// // this.ownVariables = util.clone(this.baseSet.ownVariables)
// for (const name of varnames.split(' ')) {
// this.setDefault(name, null)
// this.ownVariables.push(name)
// }
// }
/**
* Move an agent from its AgentSet/breed to be in this AgentSet/breed
*
* @param {Agent} a An agent, a member of another AgentSet
* @returns {Agent} The updated agent
*/
setBreed(a) {
// change agent a to be in this breed
// Return if `a` is already of my breed
if (a.agentSet === this) return
// Remove/insert breeds (not baseSets) from their agentsets
if (a.agentSet.isBreedSet()) a.agentSet.remove(a, 'id')
if (this.isBreedSet()) this.insert(a, 'id')
// Make list of `a`'s vars and my ownvars.
const avars = a.agentSet.ownVariables
// First remove `a`'s vars not in my ownVariables
for (const avar of avars) {
if (!this.ownVariables.includes(avar)) delete a[avar]
}
// Now add ownVariables to `a`'s vars, default to 0.
// If ownvar already in avars, it is not modified.
for (const ownvar of this.ownVariables) {
if (!avars.includes(ownvar)) a[ownvar] = 0
} // NOTE: NL uses 0, maybe we should use null?
// Give `a` my defaults/statics
return Object.setPrototypeOf(a, this.agentProto)
}
/**
* Call fcn(agent, index, array) for each item in AgentArray.
* Index & array optional. Overrides AgentArray's ask with
* additional guards for modifications in AgentSet's array.
*
* @param {Function} fcn fcn(agent, index?, array?)
*/
ask(fcn) {
if (this.length === 0) return
const lastID = this.last().id // would fail w/o 0 check above
// for (let i = 0; this[i].id <= lastID; i++) { // nope.
for (let i = 0; i < this.length && this[i].id <= lastID; i++) {
fcn(this[i], i, this)
}
}
/**
* A much stronger version of ask(fcn) with stronger mutability guards.
*
* @param {Function} fcn fcn(agent, index?, array?)
*/
askSet(fcn) {
// Manages immutability reasonably well.
if (this.length === 0) return
// Patches are static
if (this.name === 'patches') super.forLoop(fcn)
else if (this.isBaseSet()) this.baseSetAsk(fcn)
else if (this.isBreedSet()) this.cloneAsk(fcn)
}
// An ask function for mutable baseSets.
// BaseSets can only add past the end of the array.
// This allows us to manage mutations by allowing length change,
// and managing deletions only within the original length.
baseSetAsk(fcn) {
if (this.length === 0) return
const lastID = this.last().id
// Added obj's have id > lastID. Just check for deletions.
// There Be Dragons:
// - AgentSet can become length 0 if all deleted
// - For loop tricky:
// - i can become negative w/in loop:
// - i can become bigger than current AgentSet
// - Guard w/ i<len & i>=0
for (let i = 0; i < this.length; i++) {
const obj = this[i]
const id = obj.id
if (id > lastID) break
fcn(obj, i, this)
if (i >= this.length) break
if (this[i].id > id) {
while (i >= 0 && this[i].id > id) i-- // ok if -1
}
}
}
// For breeds, mutations can occur in many ways.
// This solves this by cloning the initial array and
// managing agents that have died or changed breed.
// In other words, we can be concerned only with mutations
// of the agents themselves.
cloneAsk(fcn) {
const clone = this.clone()
for (let i = 0; i < clone.length; i++) {
const obj = clone[i]
// obj.id > 0: obj.die() sets id to -1
if (obj.breed == this && obj.id > 0) {
fcn(obj, i, clone)
}
}
}
}
// export default AgentSet