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))
216 "RANDOM N => RANDOM-NUMBER
218 ARGUMENTS AND VALUES:
220 N: an integer, the upper bound of the random
221 RANDOM-NUMBER: an integer, the random result
225 Returns a random number strictly closer to zero than N.
227 If number is positive, returns a random integer greater than or equal to 0,
228 but strictly less than number.
230 If number is negative, returns a random integer less than or equal to 0,
231 but strictly greater than number.
233 If number is zero, the result is always 0.
235 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random"
236 (coerce (clnl-random:next-long (truncate n)) 'double-float))
238 (defun random-xcor ()
239 "RANDOM-XCOR => RANDOM-NUMBER
241 ARGUMENTS AND VALUES:
243 RANDOM-NUMBER: a float, the random result
247 Returns a random floating point number in the allowable range of turtle
248 coordinates along the x axis.
250 These range from min-pxcor - 0.5 (inclusive) to max-pxcor + 0.5 (exclusive)
252 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random-cor"
254 ((min (- (min-pxcor) 0.5d0))
255 (max (+ (max-pxcor) 0.5d0)))
256 (+ min (clnl-random:next-double (- max min)))))
258 (defun random-ycor ()
259 "RANDOM-YCOR => RANDOM-NUMBER
261 ARGUMENTS AND VALUES:
263 RANDOM-NUMBER: a float, the random result
267 Returns a random floating point number in the allowable range of turtle
268 coordinates along the y axis.
270 These range from min-pycor - 0.5 (inclusive) to max-pycor + 0.5 (exclusive)
272 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random-cor"
274 ((min (- (min-pycor) 0.5d0))
275 (max (+ (max-pycor) 0.5d0)))
276 (+ min (clnl-random:next-double (- max min)))))
278 (defun one-of (agent-set)
279 "ONE-OF AGENT-SET => RESULT
281 RESULT: RANDOM-AGENT | :nobody
283 ARGUMENTS AND VALUES:
285 AGENT-SET: An agent set
286 RANDOM-AGENT: an agent if AGENT-SET is non empty
290 From an agentset, returns a random agent. If the agentset is empty, returns nobody.
292 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#one-of"
294 ((agent-set-list (agent-set-list agent-set))
295 (length (length agent-set-list)))
296 (if (zerop length) :nobody (nth (clnl-random:next-int length) agent-set-list))))
299 (when (not (turtle-p *self*)) (error "Gotta call jump in turtle scope, dude (~A)" *self*))
303 (+ (turtle-xcor *self*) (* n (using-cached-sin (turtle-heading *self*))))))
307 (+ (turtle-ycor *self*) (* n (using-cached-cos (turtle-heading *self*)))))))
312 ARGUMENTS AND VALUES:
320 Sets the x-coordinate and y-coordinate for the turle. Equivalent to
321 set xcor x set ycor y, except it happens in one step inside of two.
323 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#setxy"
324 (when (not (turtle-p *self*)) (error "Gotta call setxy in turtle scope, dude (~A)" *self*))
325 (setf (turtle-xcor *self*) (wrap-x *topology* x))
326 (setf (turtle-ycor *self*) (wrap-y *topology* y)))
331 ARGUMENTS AND VALUES:
333 N: a double, the amount the turtle moves forward
338 Moves the current turtle forward N steps, one step at a time.
340 This moves forward one at a time in order to make the view updates look
341 good in the case of a purposefully slow running instance. If the number
342 is negative, the turtle moves backward.
344 If the current agent is not a turtle, it raises an error.
346 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#forward"
347 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
351 ((< (abs i) 3.2e-15) nil)
352 ((< (abs i) 1d0) (jump i))
353 (t (jump (if (> i 0d0) 1d0 -1d0)) (internal (- i (if (> i 0d0) 1d0 -1d0)))))))
356 (defun turn-right (n)
357 "TURN-RIGHT N => RESULT
359 ARGUMENTS AND VALUES:
361 N: a double, the amount the turtle turns
366 The turtle turns right by number degrees. (If number is negative, it turns left.)
368 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#right"
369 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
371 ((new-heading (+ (turtle-heading *self*) n)))
372 (setf (turtle-heading *self*)
374 ((< new-heading 0) (+ (mod new-heading -360) 360))
375 ((>= new-heading 360) (mod new-heading 360))
379 "TURN-LEFT N => RESULT
381 ARGUMENTS AND VALUES:
383 N: a double, the amount the turtle turns
388 The turtle turns left by number degrees. (If number is negative, it turns right.)
390 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#right"
393 (defun create-turtles (n)
394 "CREATE-TURTLES N => RESULT
396 ARGUMENTS AND VALUES:
398 N: an integer, the numbers of turtles to create
403 Creates number new turtles at the origin.
405 New turtles have random integer headings and the color is randomly selected
406 from the 14 primary colors. If commands are supplied, the new turtles
407 immediately run them (unimplemented).
409 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#create-turtles"
410 (loop :for i :from 1 :to n :do (create-turtle)))
412 (defun reset-ticks ()
413 "RESET-TICKS => RESULT
415 ARGUMENTS AND VALUES:
421 Resets the tick counter to zero, sets up all plots, then updates all plots.
423 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#reset-ticks"
427 "RESET-TICKS => RESULT
429 ARGUMENTS AND VALUES:
435 Advances the tick counter by one and updates all plots.
437 If the tick counter has not been started yet with reset-ticks, an error results.
439 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#tick"
441 (when (not *ticks*) (error "reset-ticks must be called"))
445 "TICKS => CURRENT-TICKS
447 ARGUMENTS AND VALUES:
449 CURRENT-TICKS: A positiv double, representing the current number of ticks
453 Reports the current value of the tick counter. The result is always a number and never negative.
455 If the tick counter has not been started yet with reset-ticks, an error results.
457 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#ticks"
458 (when (not *ticks*) (error "reset-ticks must be called"))
461 (defun create-world (&key dims)
462 "CREATE-WORLD &key DIMS => RESULT
464 DIMS: (:xmin XMIN :xmax XMAX :ymin YMIN :ymax YMAX)
466 ARGUMENTS AND VALUES:
469 XMIN: An integer representing the minimum patch coord in X
470 XMAX: An integer representing the maximum patch coord in X
471 YMIN: An integer representing the minimum patch coord in Y
472 YMAX: An integer representing the maximum patch coord in Y
476 Initializes the world in the NVM.
478 This should be called before using the engine in any real capacity. If
479 called when an engine is already running, it may do somethign weird."
480 (setf *dimensions* dims)
484 :for y :from (max-pycor) :downto (min-pycor)
486 :for x :from (min-pxcor) :to (max-pxcor)
488 :xcor (coerce x 'double-float)
489 :ycor (coerce y 'double-float)
492 (setf *current-id* 0))
494 ; These match netlogo's dump
495 (defgeneric dump-object (o))
497 (defmethod dump-object ((n double-float))
498 (multiple-value-bind (int rem) (floor n)
500 (format nil "~A" int)
502 ((output (format nil "~D" n)))
503 ; Someday we'll have d<posint>, but this is not that day!
504 (cl-ppcre:regex-replace "d-" (cl-ppcre:regex-replace "d0" output "") "E-")))))
506 (defmethod dump-object ((o string)) (format nil "~A" (cl-ppcre:regex-replace-all "\"" (format nil "~S" o) "\"\"")))
508 (defmethod dump-object ((o (eql t))) "true")
509 (defmethod dump-object ((o (eql nil))) "false")
511 (defmethod dump-object ((o list)) (format nil "[~{~A~^ ~}]" (mapcar #'dump-object o)))
513 (defmethod dump-object ((o patch))
514 (format nil "(patch ~A ~A)" (dump-object (patch-xcor o)) (dump-object (patch-ycor o))))
516 (defmethod dump-object ((o turtle)) (format nil "(turtle ~A)" (dump-object (turtle-who o))))
517 (defmethod dump-object ((o (eql :nobody))) (format nil "nobody"))
519 (defun current-state ()
520 "CURRENT-STATE => WORLD-STATE
522 ARGUMENTS AND VALUES:
524 WORLD-STATE: A list, the current state of the whole world
528 Dumps out the state of the world.
530 This is useful for visualizations and also storing in a common lisp
531 data structure for easy usage in a common lisp instance. It's preferable
532 to use this when working with the nvm than the output done by export-world.
534 Currently this only dumps out turtle and patch information.
536 This is called CURRENT-STATE because export-world is an actual primitive
542 :color (turtle-color turtle)
543 :xcor (turtle-xcor turtle)
544 :ycor (turtle-ycor turtle)
545 :heading (turtle-heading turtle)
546 :size (turtle-size turtle)))
551 :color (patch-color patch)
552 :xcor (patch-xcor patch)
553 :ycor (patch-ycor patch)))
556 (defun export-turtles ()
561 "\"who\",\"color\",\"heading\",\"xcor\",\"ycor\",\"shape\",\"label\",\"label-color\","
562 "\"breed\",\"hidden?\",\"size\",\"pen-size\",\"pen-mode\""))
566 "\"~A\",\"~A\",\"~A\",\"~A\",\"~A\",\"\"\"default\"\"\",\"~A\",\"~A\",\"{all-turtles}\",\"false\",\"~A\",~A"
567 (dump-object (turtle-who turtle))
568 (dump-object (turtle-color turtle))
569 (dump-object (turtle-heading turtle))
570 (dump-object (turtle-xcor turtle))
571 (dump-object (turtle-ycor turtle))
572 (dump-object (turtle-label turtle))
573 (dump-object (turtle-label-color turtle))
574 (dump-object (turtle-size turtle))
575 "\"1\",\"\"\"up\"\"\""))
578 (defun export-patches ()
582 "\"pxcor\",\"pycor\",\"pcolor\",\"plabel\",\"plabel-color\"")
586 "\"~A\",\"~A\",\"~A\",\"\"\"\"\"\",\"9.9\""
587 (dump-object (patch-xcor patch))
588 (dump-object (patch-ycor patch))
589 (dump-object (patch-color patch))))
592 (defun export-world ()
593 "EXPORT-WORLD => WORLD-CSV
595 ARGUMENTS AND VALUES:
597 WORLD-CSV: A string, the csv of the world
601 Dumps out a csv matching NetLogo's export world.
603 This is useful for serializing the current state of the engine in order
604 to compare against NetLogo or to reimport later. Contains everything needed
605 to boot up a NetLogo instance in the exact same state."
606 (format nil "~{~A~%~}"
608 (format nil "~S" "RANDOM STATE")
609 (format nil "~S" (clnl-random:export))
611 (format nil "~S" "GLOBALS")
613 "\"min-pxcor\",\"max-pxcor\",\"min-pycor\",\"max-pycor\",\"perspective\",\"subject\","
614 "\"nextIndex\",\"directed-links\",\"ticks\",")
615 (format nil "\"~A\",\"~A\",\"~A\",\"~A\",\"0\",\"nobody\",\"~A\",\"\"\"NEITHER\"\"\",\"-1\""
616 (min-pxcor) (max-pxcor) (min-pycor) (max-pycor) *current-id*)
618 (format nil "~{~A~^~%~}" (export-turtles))
620 (format nil "~{~A~^~%~}" (export-patches))
622 (format nil "~S" "LINKS")
623 "\"end1\",\"end2\",\"color\",\"label\",\"label-color\",\"hidden?\",\"breed\",\"thickness\",\"shape\",\"tie-mode\""