1 (in-package #:clnl-nvm)
3 ; Implementations of all the things the nvm can do.
10 VALUE: a NetLogo value
15 A command that prints the given NetLogo value to the command center.
17 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#show"
18 (format t "Showing: ~A~%" (dump-object value)))
20 (defun lookup-color (color)
21 "LOOKUP-COLOR COLOR => COLOR-NUMBER
25 COLOR: a symbol representing a color
26 COLOR-NUMBER: the NetLogo color integer
30 Returns the number used to represent colors in NetLogo.
32 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#Constants"
51 (defun create-turtle ()
58 :who (coerce *current-id* 'double-float)
59 :color (coerce (+ 5 (* 10 (clnl-random:next-int 14))) 'double-float)
60 :heading (coerce (clnl-random:next-int 360) 'double-float)
70 RESULT: undefined, commands don't return
74 The turtle or link dies
76 A dead agent ceases to exist. The effects of this include:
77 - The agent will not execute any further code.
78 - The agent will disappear from any agentsets it was in, reducing the size of those agentsets by one.
79 - Any variable that was storing the agent will now instead have nobody in it.
80 - If the dead agent was a turtle, every link connected to it also dies.
81 - If the observer was watching or following the agent, the observer's perspective resets.
83 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#die"
84 (when (not (turtle-p *self*)) (error "Gotta call die in turtle scope, dude (~A)" *self*))
85 (setf (turtle-who *self*) -1)
86 (setf *turtles* (remove *self* *turtles*)))
89 "PATCHES => ALL-PATCHES
93 ALL-PATCHES: a NetLogo agentset, all patches
97 Reports the agentset consisting of all the patches.
99 This agentset is special in that it represents the living patches
100 each time it's used, so changes depending on the state of the engine.
102 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#patches"
106 "TURTLES => ALL-TURTLES
108 ARGUMENTS AND VALUES:
110 ALL-TURTLES: a NetLogo agentset, all turtles
114 Reports the agentset consisting of all the turtles.
116 This agentset is special in that it represents the living turtles
117 each time it's used, so changes depending on the state of the engine.
119 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#turtles"
122 (defun ask (agent-set fn)
123 "ASK AGENT-SET FN => RESULT
125 ARGUMENTS AND VALUES:
127 AGENT-SET: a NetLogo agentset
128 FN: a function, run on each agent
129 RESULT: undefined, commands don't return
133 ASK is equivalent to ask in NetLogo.
135 The specified AGENT-SET runs the given FN. The order in which the agents
136 are run is random each time, and only agents that are in the set at the
137 beginning of the call.
139 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#ask"
141 ((iter (shufflerator (agent-set-list agent-set))))
143 :for agent := (funcall iter)
145 :do (let ((*myself* *self*) (*self* agent)) (funcall fn)))))
147 (defun of (fn agent-set)
148 "OF FN AGENT-SET => RESULT
150 ARGUMENTS AND VALUES:
152 FN: a function, run on each agent
153 AGENT-SET: a NetLogo agentset
158 OF is equivalent to of in NetLogo.
160 The specified AGENT-SET runs the given FN. The order in which the agents
161 are run is random each time, and only agents that are in the set at the
162 beginning of the call. A list is returned of the returned valuse of
165 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#of"
167 ((iter (shufflerator (agent-set-list agent-set))))
169 :for agent := (funcall iter)
171 :collect (let ((*myself* *self*) (*self* agent)) (funcall fn)))))
173 (defun shufflerator (agent-set-list)
175 ((copy (copy-list agent-set-list))
181 ((idx (when (< i (1- (length copy))) (+ i (clnl-random:next-int (- (length copy) i))))))
182 (when idx (setf agent (nth idx copy)))
183 (when idx (setf (nth idx copy) (nth i copy)))
185 (fetch) ; we pre-fetch because netlogo does, rng sync hype!
188 ((> i (length copy)) nil)
189 ((= i (length copy)) (incf i) (car (last copy)))
190 (t (let ((result agent)) (fetch) result)))))))
192 (defun random-float (n)
193 "RANDOM-FLOAT N => RANDOM-NUMBER
195 ARGUMENTS AND VALUES:
197 N: a double, the upper bound of the random float
198 RANDOM-NUMBER: a double, the random result
202 Returns a random number strictly closer to zero than N.
204 If number is positive, returns a random floating point number greater than
205 or equal to 0 but strictly less than number.
207 If number is negative, returns a random floating point number less than or equal
208 to 0, but strictly greater than number.
210 If number is zero, the result is always 0.
212 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random-float"
213 (clnl-random:next-double n))
215 (defun one-of (agent-set)
216 "ONE-OF AGENT-SET => RESULT
218 RESULT: RANDOM-AGENT | :nobody
220 ARGUMENTS AND VALUES:
222 AGENT-SET: An agent set
223 RANDOM-AGENT: an agent if AGENT-SET is non empty
227 From an agentset, returns a random agent. If the agentset is empty, returns nobody.
229 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#one-of"
231 ((agent-set-list (agent-set-list agent-set))
232 (length (length agent-set-list)))
233 (if (zerop length) :nobody (nth (clnl-random:next-int length) agent-set-list))))
236 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
240 (+ (turtle-xcor *self*) (* n (using-cached-sin (turtle-heading *self*))))))
244 (+ (turtle-ycor *self*) (* n (using-cached-cos (turtle-heading *self*)))))))
249 ARGUMENTS AND VALUES:
251 N: a double, the amount the turtle moves forward
256 Moves the current turtle forward N steps, one step at a time.
258 This moves forward one at a time in order to make the view updates look
259 good in the case of a purposefully slow running instance. If the number
260 is negative, the turtle moves backward.
262 If the current agent is not a turtle, it raises an error.
264 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#forward"
265 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
269 ((< (abs i) 3.2e-15) nil)
270 ((< (abs i) 1d0) (jump i))
271 (t (jump (if (> i 0d0) 1d0 -1d0)) (internal (- i (if (> i 0d0) 1d0 -1d0)))))))
274 (defun turn-right (n)
275 "TURN-RIGHT N => RESULT
277 ARGUMENTS AND VALUES:
279 N: a double, the amount the turtle turns
284 The turtle turns right by number degrees. (If number is negative, it turns left.)
286 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#right"
287 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
289 ((new-heading (+ (turtle-heading *self*) n)))
290 (setf (turtle-heading *self*)
292 ((< new-heading 0) (+ (mod new-heading -360) 360))
293 ((>= new-heading 360) (mod new-heading 360))
297 "TURN-LEFT N => RESULT
299 ARGUMENTS AND VALUES:
301 N: a double, the amount the turtle turns
306 The turtle turns left by number degrees. (If number is negative, it turns right.)
308 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#right"
311 (defun create-turtles (n)
312 "CREATE-TURTLES N => RESULT
314 ARGUMENTS AND VALUES:
316 N: an integer, the numbers of turtles to create
321 Creates number new turtles at the origin.
323 New turtles have random integer headings and the color is randomly selected
324 from the 14 primary colors. If commands are supplied, the new turtles
325 immediately run them (unimplemented).
327 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#create-turtles"
328 (loop :for i :from 1 :to n :do (create-turtle)))
330 (defun reset-ticks ()
331 "RESET-TICKS => RESULT
333 ARGUMENTS AND VALUES:
339 Resets the tick counter to zero, sets up all plots, then updates all plots.
341 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#reset-ticks"
345 "RESET-TICKS => RESULT
347 ARGUMENTS AND VALUES:
353 Advances the tick counter by one and updates all plots.
355 If the tick counter has not been started yet with reset-ticks, an error results.
357 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#tick"
359 (when (not *ticks*) (error "reset-ticks must be called"))
363 "TICKS => CURRENT-TICKS
365 ARGUMENTS AND VALUES:
367 CURRENT-TICKS: A positiv double, representing the current number of ticks
371 Reports the current value of the tick counter. The result is always a number and never negative.
373 If the tick counter has not been started yet with reset-ticks, an error results.
375 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#ticks"
376 (when (not *ticks*) (error "reset-ticks must be called"))
379 (defun create-world (&key dims)
380 "CREATE-WORLD &key DIMS => RESULT
382 DIMS: (:xmin XMIN :xmax XMAX :ymin YMIN :ymax YMAX)
384 ARGUMENTS AND VALUES:
387 XMIN: An integer representing the minimum patch coord in X
388 XMAX: An integer representing the maximum patch coord in X
389 YMIN: An integer representing the minimum patch coord in Y
390 YMAX: An integer representing the maximum patch coord in Y
394 Initializes the world in the NVM.
396 This should be called before using the engine in any real capacity. If
397 called when an engine is already running, it may do somethign weird."
398 (setf *dimensions* dims)
402 :for y :from (max-pycor) :downto (min-pycor)
404 :for x :from (min-pxcor) :to (max-pxcor)
406 :xcor (coerce x 'double-float)
407 :ycor (coerce y 'double-float)
410 (setf *current-id* 0))
412 ; These match netlogo's dump
413 (defgeneric dump-object (o))
415 (defmethod dump-object ((n double-float))
416 (multiple-value-bind (int rem) (floor n)
418 (format nil "~A" int)
420 ((output (format nil "~D" n)))
421 ; Someday we'll have d<posint>, but this is not that day!
422 (cl-ppcre:regex-replace "d-" (cl-ppcre:regex-replace "d0" output "") "E-")))))
424 (defmethod dump-object ((o string)) (format nil "~A" (cl-ppcre:regex-replace-all "\"" (format nil "~S" o) "\"\"")))
426 (defmethod dump-object ((o (eql t))) "true")
427 (defmethod dump-object ((o (eql nil))) "false")
429 (defmethod dump-object ((o list)) (format nil "[~{~A~^ ~}]" (mapcar #'dump-object o)))
431 (defmethod dump-object ((o patch))
432 (format nil "(patch ~A ~A)" (dump-object (patch-xcor o)) (dump-object (patch-ycor o))))
434 (defmethod dump-object ((o turtle)) (format nil "(turtle ~A)" (dump-object (turtle-who o))))
435 (defmethod dump-object ((o (eql :nobody))) (format nil "nobody"))
437 (defun current-state ()
438 "CURRENT-STATE => WORLD-STATE
440 ARGUMENTS AND VALUES:
442 WORLD-STATE: A list, the current state of the whole world
446 Dumps out the state of the world.
448 This is useful for visualizations and also storing in a common lisp
449 data structure for easy usage in a common lisp instance. It's preferable
450 to use this when working with the nvm than the output done by export-world.
452 Currently this only dumps out turtle and patch information.
454 This is called CURRENT-STATE because export-world is an actual primitive
460 :color (turtle-color turtle)
461 :xcor (turtle-xcor turtle)
462 :ycor (turtle-ycor turtle)
463 :heading (turtle-heading turtle)
464 :size (turtle-size turtle)))
469 :color (patch-color patch)
470 :xcor (patch-xcor patch)
471 :ycor (patch-ycor patch)))
474 (defun export-turtles ()
479 "\"who\",\"color\",\"heading\",\"xcor\",\"ycor\",\"shape\",\"label\",\"label-color\","
480 "\"breed\",\"hidden?\",\"size\",\"pen-size\",\"pen-mode\""))
484 "\"~A\",\"~A\",\"~A\",\"~A\",\"~A\",\"\"\"default\"\"\",\"~A\",\"~A\",\"{all-turtles}\",\"false\",\"~A\",~A"
485 (dump-object (turtle-who turtle))
486 (dump-object (turtle-color turtle))
487 (dump-object (turtle-heading turtle))
488 (dump-object (turtle-xcor turtle))
489 (dump-object (turtle-ycor turtle))
490 (dump-object (turtle-label turtle))
491 (dump-object (turtle-label-color turtle))
492 (dump-object (turtle-size turtle))
493 "\"1\",\"\"\"up\"\"\""))
496 (defun export-patches ()
500 "\"pxcor\",\"pycor\",\"pcolor\",\"plabel\",\"plabel-color\"")
504 "\"~A\",\"~A\",\"~A\",\"\"\"\"\"\",\"9.9\""
505 (dump-object (patch-xcor patch))
506 (dump-object (patch-ycor patch))
507 (dump-object (patch-color patch))))
510 (defun export-world ()
511 "EXPORT-WORLD => WORLD-CSV
513 ARGUMENTS AND VALUES:
515 WORLD-CSV: A string, the csv of the world
519 Dumps out a csv matching NetLogo's export world.
521 This is useful for serializing the current state of the engine in order
522 to compare against NetLogo or to reimport later. Contains everything needed
523 to boot up a NetLogo instance in the exact same state."
524 (format nil "~{~A~%~}"
526 (format nil "~S" "RANDOM STATE")
527 (format nil "~S" (clnl-random:export))
529 (format nil "~S" "GLOBALS")
531 "\"min-pxcor\",\"max-pxcor\",\"min-pycor\",\"max-pycor\",\"perspective\",\"subject\","
532 "\"nextIndex\",\"directed-links\",\"ticks\",")
533 (format nil "\"~A\",\"~A\",\"~A\",\"~A\",\"0\",\"nobody\",\"~A\",\"\"\"NEITHER\"\"\",\"-1\""
534 (min-pxcor) (max-pxcor) (min-pycor) (max-pycor) *current-id*)
536 (format nil "~{~A~^~%~}" (export-turtles))
538 (format nil "~{~A~^~%~}" (export-patches))
540 (format nil "~S" "LINKS")
541 "\"end1\",\"end2\",\"color\",\"label\",\"label-color\",\"hidden?\",\"breed\",\"thickness\",\"shape\",\"tie-mode\""