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 (&optional base-turtle)
53 ((new-turtle (make-turtle
54 :who (coerce *current-id* 'double-float)
55 :color (if base-turtle
56 (turtle-color base-turtle)
57 (coerce (+ 5 (* 10 (clnl-random:next-int 14))) 'double-float))
58 :heading (if base-turtle
59 (turtle-heading base-turtle)
60 (coerce (clnl-random:next-int 360) 'double-float))
61 :shape (breed-default-shape :turtles)
62 :xcor (if base-turtle (turtle-xcor base-turtle) 0d0)
63 :ycor (if base-turtle (turtle-ycor base-turtle) 0d0))))
64 (setf *turtles* (nconc *turtles* (list new-turtle)))
73 RESULT: undefined, commands don't return
77 The turtle or link dies
79 A dead agent ceases to exist. The effects of this include:
80 - The agent will not execute any further code.
81 - The agent will disappear from any agentsets it was in, reducing the size of those agentsets by one.
82 - Any variable that was storing the agent will now instead have nobody in it.
83 - If the dead agent was a turtle, every link connected to it also dies.
84 - If the observer was watching or following the agent, the observer's perspective resets.
86 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#die"
87 (when (not (turtle-p *self*)) (error "Gotta call die in turtle scope, dude (~A)" *self*))
88 (setf (turtle-who *self*) -1)
89 (setf *turtles* (remove *self* *turtles*)))
92 "PATCHES => ALL-PATCHES
96 ALL-PATCHES: a NetLogo agentset, all patches
100 Reports the agentset consisting of all the patches.
102 This agentset is special in that it represents the living patches
103 each time it's used, so changes depending on the state of the engine.
105 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#patches"
109 "TURTLES => ALL-TURTLES
111 ARGUMENTS AND VALUES:
113 ALL-TURTLES: a NetLogo agentset, all turtles
117 Reports the agentset consisting of all the turtles.
119 This agentset is special in that it represents the living turtles
120 each time it's used, so changes depending on the state of the engine.
122 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#turtles"
125 (defun ask (agent-or-agentset fn)
126 "ASK AGENT-OR-AGENTSET FN => RESULT
128 AGENT-OR-AGENTSET: AGENT | AGENTSET
130 ARGUMENTS AND VALUES:
132 FN: a function, run on each agent
133 RESULT: undefined, commands don't return
134 AGENT: a NetLogo agent
135 AGENTSET: a NetLogo agentset
139 ASK is equivalent to ask in NetLogo.
141 The specified AGENTSET or AGENT runs the given FN. In the case of an
142 AGENTSET, the order in which the agents are run is random each time,
143 and only agents that are in the set at the beginning of the call.
145 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#ask"
147 ((agentset-p agent-or-agentset)
149 ((iter (shufflerator (agentset-list agent-or-agentset))))
151 :for agent := (funcall iter)
153 :do (let ((*myself* *self*) (*self* agent)) (funcall fn)))))
154 ((agent-p agent-or-agentset)
155 (let ((*myself* *self*) (*self* agent-or-agentset)) (funcall fn)))
157 (error "Ask requires an agentset or agent but got: ~A" agent-or-agentset))))
159 (defun count (agentset)
162 ARGUMENTS AND VALUES:
164 AGENTSET: a NetLogo agentset
169 COUNT is equivalent to count in NetLogo. Returns N, the number of
172 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#count"
173 (coerce (length (agentset-list agentset)) 'double-float))
178 ARGUMENTS AND VALUES:
184 Clears ticks, turtles, patches, globals (unimplemented).
186 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#clear-all"
191 (defun of (fn agent-or-agentset)
192 "OF FN AGENT-OR-AGENTSET => RESULT
194 AGENT-OR-AGENTSET: AGENT | AGENTSET
195 RESULT: RESULT-LIST | RESULT-VALUE
197 ARGUMENTS AND VALUES:
199 FN: a function, run on each agent
200 AGENT: a NetLogo agent
201 AGENTSET: a NetLogo agentset
203 RESULT-VALUE: a single value
207 OF is equivalent to of in NetLogo.
209 The specified AGENTSET or AGENT runs the given FN. In the case of an
210 AGENTSET, the order in which the agents are run is random each time,
211 and only agents that are in the set at the beginning of the call.
213 RESULT-LIST is returned when the input is an AGENTSET, but RESULT-VALUE
214 is returned when only passed an AGENT.
216 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#of"
218 ((agentset-p agent-or-agentset)
220 ((iter (shufflerator (agentset-list agent-or-agentset))))
222 :for agent := (funcall iter)
224 :collect (let ((*myself* *self*) (*self* agent)) (funcall fn)))))
225 ((agent-p agent-or-agentset)
226 (let ((*myself* *self*) (*self* agent-or-agentset)) (funcall fn)))
228 (error "Of requires an agentset or agent but got: ~A" agent-or-agentset))))
230 (defun with (agentset fn)
231 "WITH AGENTSET FN => RESULT-AGENTSET
233 ARGUMENTS AND VALUES:
235 AGENTSET: a NetLogo agentset
236 FN: a boolean function, run on each agent to determine if included
237 RESULT-AGENTSET: an agentset of valid agents
241 WITH is equivalent to with in NetLogo.
243 Returns a new agentset containing only those agents that reported true
246 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#with"
250 (let ((*myself* *self*) (*self* agent)) (funcall fn)))
251 (agentset-list agentset))
252 (agentset-breed agentset)))
254 (defun shufflerator (agentset-list)
256 ((copy (copy-list agentset-list))
262 ((idx (when (< i (1- (length copy))) (+ i (clnl-random:next-int (- (length copy) i))))))
263 (when idx (setf agent (nth idx copy)))
264 (when idx (setf (nth idx copy) (nth i copy)))
266 (fetch) ; we pre-fetch because netlogo does, rng sync hype!
269 ((> i (length copy)) nil)
270 ((= i (length copy)) (incf i) (car (last copy)))
271 (t (let ((result agent)) (fetch) result)))))))
273 (defun random-float (n)
274 "RANDOM-FLOAT N => RANDOM-NUMBER
276 ARGUMENTS AND VALUES:
278 N: a double, the upper bound of the random float
279 RANDOM-NUMBER: a double, the random result
283 Returns a random number strictly closer to zero than N.
285 If number is positive, returns a random floating point number greater than
286 or equal to 0 but strictly less than number.
288 If number is negative, returns a random floating point number less than or equal
289 to 0, but strictly greater than number.
291 If number is zero, the result is always 0.
293 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random-float"
294 (clnl-random:next-double n))
297 "RANDOM N => RANDOM-NUMBER
299 ARGUMENTS AND VALUES:
301 N: an integer, the upper bound of the random
302 RANDOM-NUMBER: an integer, the random result
306 Returns a random number strictly closer to zero than N.
308 If number is positive, returns a random integer greater than or equal to 0,
309 but strictly less than number.
311 If number is negative, returns a random integer less than or equal to 0,
312 but strictly greater than number.
314 If number is zero, the result is always 0.
316 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random"
317 (coerce (clnl-random:next-long (truncate n)) 'double-float))
319 (defun random-xcor ()
320 "RANDOM-XCOR => RANDOM-NUMBER
322 ARGUMENTS AND VALUES:
324 RANDOM-NUMBER: a float, the random result
328 Returns a random floating point number in the allowable range of turtle
329 coordinates along the x axis.
331 These range from min-pxcor - 0.5 (inclusive) to max-pxcor + 0.5 (exclusive)
333 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random-cor"
335 ((min (- (min-pxcor) 0.5d0))
336 (max (+ (max-pxcor) 0.5d0)))
337 (+ min (clnl-random:next-double (- max min)))))
339 (defun random-ycor ()
340 "RANDOM-YCOR => RANDOM-NUMBER
342 ARGUMENTS AND VALUES:
344 RANDOM-NUMBER: a float, the random result
348 Returns a random floating point number in the allowable range of turtle
349 coordinates along the y axis.
351 These range from min-pycor - 0.5 (inclusive) to max-pycor + 0.5 (exclusive)
353 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#random-cor"
355 ((min (- (min-pycor) 0.5d0))
356 (max (+ (max-pycor) 0.5d0)))
357 (+ min (clnl-random:next-double (- max min)))))
359 (defun one-of (list-or-agentset)
360 "ONE-OF LIST-OR-AGENTSET => RESULT
362 LIST-OR-AGENTSET: LIST | AGENTSET
363 RESULT: RANDOM-VALUE | RANDOM-AGENT | :nobody
365 ARGUMENTS AND VALUES:
368 AGENTSET: An agent set
369 RANDOM-VALUE: a value in LIST
370 RANDOM-AGENT: an agent if AGENTSET is non empty
374 From an AGENTSET, returns a RANDOM-AGENT. If the agentset is empty, returns :nobody.
375 From a list, returns a RANDOM-VALUE. If the list is empty, an error occurs.
377 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#one-of"
379 ((agentset-p list-or-agentset)
381 ((agentset-list (agentset-list list-or-agentset))
382 (length (length agentset-list)))
383 (if (zerop length) :nobody (nth (clnl-random:next-int length) agentset-list))))
384 ((listp list-or-agentset)
386 ((length (length list-or-agentset)))
388 (error "one-of requires a nonempty list")
389 (nth (clnl-random:next-int length) list-or-agentset))))
390 (t (error "one-of requires a list or agentset"))))
393 (when (not (turtle-p *self*)) (error "Gotta call jump in turtle scope, dude (~A)" *self*))
397 (+ (turtle-xcor *self*) (* n (using-cached-sin (turtle-heading *self*))))))
401 (+ (turtle-ycor *self*) (* n (using-cached-cos (turtle-heading *self*)))))))
406 ARGUMENTS AND VALUES:
414 Sets the x-coordinate and y-coordinate for the turle. Equivalent to
415 set xcor x set ycor y, except it happens in one step inside of two.
417 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#setxy"
418 (when (not (turtle-p *self*)) (error "Gotta call setxy in turtle scope, dude (~A)" *self*))
419 (setf (turtle-xcor *self*) (wrap-x *topology* x))
420 (setf (turtle-ycor *self*) (wrap-y *topology* y)))
422 (defun set-default-shape (breed shape)
423 "SET-DEFAULT-SHAPE BREED SHAPE => RESULT
425 ARGUMENTS AND VALUES:
433 Specifies a default initial shape for a BREED. When a turtle, or it changes breeds,
434 its shape is set to the given shape.
436 SET-DEFAULT-SHAPE doesn't affect existing agents, only agents you create afterwards.
438 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#set-default-shape"
439 (when (not (breed-p breed)) (error "Need a valid breed"))
440 (setf (breed-default-shape breed) shape))
445 ARGUMENTS AND VALUES:
447 N: a double, the amount the turtle moves forward
452 Moves the current turtle forward N steps, one step at a time.
454 This moves forward one at a time in order to make the view updates look
455 good in the case of a purposefully slow running instance. If the number
456 is negative, the turtle moves backward.
458 If the current agent is not a turtle, it raises an error.
460 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#forward"
461 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
465 ((< (abs i) 3.2e-15) nil)
466 ((< (abs i) 1d0) (jump i))
467 (t (jump (if (> i 0d0) 1d0 -1d0)) (internal (- i (if (> i 0d0) 1d0 -1d0)))))))
470 (defun turn-right (n)
471 "TURN-RIGHT N => RESULT
473 ARGUMENTS AND VALUES:
475 N: a double, the amount the turtle turns
480 The turtle turns right by number degrees. (If number is negative, it turns left.)
482 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#right"
483 (when (not (turtle-p *self*)) (error "Gotta call fd in turtle scope, dude (~A)" *self*))
485 ((new-heading (+ (turtle-heading *self*) n)))
486 (setf (turtle-heading *self*)
488 ((< new-heading 0) (+ (mod new-heading -360) 360))
489 ((>= new-heading 360) (mod new-heading 360))
493 "TURN-LEFT N => RESULT
495 ARGUMENTS AND VALUES:
497 N: a double, the amount the turtle turns
502 The turtle turns left by number degrees. (If number is negative, it turns right.)
504 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#right"
507 (defun create-turtles (n &optional fn)
508 "CREATE-TURTLES N &optional FN => RESULT
510 ARGUMENTS AND VALUES:
512 N: an integer, the numbers of turtles to create
513 FN: A function, applied to each turtle after creation
518 Creates number new turtles at the origin.
520 New turtles have random integer headings and the color is randomly selected
521 from the 14 primary colors. If a function is supplied, the new turtles
524 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#create-turtles"
526 ((new-turtles (loop :repeat n :collect (create-turtle))))
527 (when fn (ask (list->agentset new-turtles :turtles) fn))))
529 (defun hatch (n &optional fn)
530 "HATCH N &optional FN => RESULT
532 ARGUMENTS AND VALUES:
534 N: an integer, the numbers of turtles to hatch
535 FN: A function, applied to each turtle after creation
540 The turtle in *self* creates N new turtles. Each new turtle inherits of all its
541 variables, including its location, from self.
543 If FN is supplied, the new turtles immediately run it.
545 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#hatch"
546 (when (not (turtle-p *self*)) (error "Can only hatch from turtle scope"))
548 ((new-turtles (loop :repeat n :collect (create-turtle *self*))))
549 (when fn (ask (list->agentset new-turtles :turtles) fn))))
551 (defun reset-ticks ()
552 "RESET-TICKS => RESULT
554 ARGUMENTS AND VALUES:
560 Resets the tick counter to zero, sets up all plots, then updates all plots.
562 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#reset-ticks"
566 "RESET-TICKS => RESULT
568 ARGUMENTS AND VALUES:
574 Advances the tick counter by one and updates all plots.
576 If the tick counter has not been started yet with reset-ticks, an error results.
578 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#tick"
580 (when (not *ticks*) (error "reset-ticks must be called"))
584 "TICKS => CURRENT-TICKS
586 ARGUMENTS AND VALUES:
588 CURRENT-TICKS: A positiv double, representing the current number of ticks
592 Reports the current value of the tick counter. The result is always a number and never negative.
594 If the tick counter has not been started yet with reset-ticks, an error results.
596 See http://ccl.northwestern.edu/netlogo/docs/dictionary.html#ticks"
597 (when (not *ticks*) (error "reset-ticks must be called"))
600 (defun clear-patches ()
604 :for y :from (max-pycor) :downto (min-pycor)
606 :for x :from (min-pxcor) :to (max-pxcor)
608 :xcor (coerce x 'double-float)
609 :ycor (coerce y 'double-float)
612 (defun clear-turtles ()
614 (setf *current-id* 0))
616 (defun clear-ticks ()
619 (defun create-world (&key dims)
620 "CREATE-WORLD &key DIMS => RESULT
622 DIMS: (:xmin XMIN :xmax XMAX :ymin YMIN :ymax YMAX)
624 ARGUMENTS AND VALUES:
627 XMIN: An integer representing the minimum patch coord in X
628 XMAX: An integer representing the maximum patch coord in X
629 YMIN: An integer representing the minimum patch coord in Y
630 YMAX: An integer representing the maximum patch coord in Y
634 Initializes the world in the NVM.
636 This should be called before using the engine in any real capacity. If
637 called when an engine is already running, it may do somethign weird."
638 (setf *dimensions* dims)
639 (setf *breeds* (list (list :turtles "default")))
644 ; These match netlogo's dump
645 (defgeneric dump-object (o))
647 (defmethod dump-object ((n double-float))
648 (multiple-value-bind (int rem) (floor n)
650 (format nil "~A" int)
652 ((output (format nil "~D" n)))
653 ; Someday we'll have d<posint>, but this is not that day!
654 (cl-ppcre:regex-replace "d-" (cl-ppcre:regex-replace "d0" output "") "E-")))))
656 (defmethod dump-object ((o string)) (format nil "~A" (cl-ppcre:regex-replace-all "\"" (format nil "~S" o) "\"\"")))
658 (defmethod dump-object ((o (eql t))) "true")
659 (defmethod dump-object ((o (eql nil))) "false")
661 (defmethod dump-object ((o list))
663 ((agentset-p o) (format nil "(agentset, ~A ~A)" (dump-object (count o)) (string-downcase (agentset-breed o))))
664 (t (format nil "[~{~A~^ ~}]" (mapcar #'dump-object o)))))
666 (defmethod dump-object ((o patch))
667 (format nil "(patch ~A ~A)" (dump-object (patch-xcor o)) (dump-object (patch-ycor o))))
669 (defmethod dump-object ((o turtle)) (format nil "(turtle ~A)" (dump-object (turtle-who o))))
670 (defmethod dump-object ((o (eql :nobody))) (format nil "nobody"))
672 (defun current-state ()
673 "CURRENT-STATE => WORLD-STATE
675 ARGUMENTS AND VALUES:
677 WORLD-STATE: A list, the current state of the whole world
681 Dumps out the state of the world.
683 This is useful for visualizations and also storing in a common lisp
684 data structure for easy usage in a common lisp instance. It's preferable
685 to use this when working with the nvm than the output done by export-world.
687 Currently this only dumps out turtle and patch information.
689 This is called CURRENT-STATE because export-world is an actual primitive
695 :color (turtle-color turtle)
696 :xcor (turtle-xcor turtle)
697 :ycor (turtle-ycor turtle)
698 :heading (turtle-heading turtle)
699 :size (turtle-size turtle)))
704 :color (patch-color patch)
705 :xcor (patch-xcor patch)
706 :ycor (patch-ycor patch)))
709 (defun export-turtles ()
714 "\"who\",\"color\",\"heading\",\"xcor\",\"ycor\",\"shape\",\"label\",\"label-color\","
715 "\"breed\",\"hidden?\",\"size\",\"pen-size\",\"pen-mode\""))
719 "\"~A\",\"~A\",\"~A\",\"~A\",\"~A\",\"~A\",\"~A\",\"~A\",\"{all-turtles}\",\"false\",\"~A\",~A"
720 (dump-object (turtle-who turtle))
721 (dump-object (turtle-color turtle))
722 (dump-object (turtle-heading turtle))
723 (dump-object (turtle-xcor turtle))
724 (dump-object (turtle-ycor turtle))
725 (dump-object (turtle-shape turtle))
726 (dump-object (turtle-label turtle))
727 (dump-object (turtle-label-color turtle))
728 (dump-object (turtle-size turtle))
729 "\"1\",\"\"\"up\"\"\""))
732 (defun export-patches ()
736 "\"pxcor\",\"pycor\",\"pcolor\",\"plabel\",\"plabel-color\"")
740 "\"~A\",\"~A\",\"~A\",\"\"\"\"\"\",\"9.9\""
741 (dump-object (patch-xcor patch))
742 (dump-object (patch-ycor patch))
743 (dump-object (patch-color patch))))
746 (defun export-world ()
747 "EXPORT-WORLD => WORLD-CSV
749 ARGUMENTS AND VALUES:
751 WORLD-CSV: A string, the csv of the world
755 Dumps out a csv matching NetLogo's export world.
757 This is useful for serializing the current state of the engine in order
758 to compare against NetLogo or to reimport later. Contains everything needed
759 to boot up a NetLogo instance in the exact same state."
760 (format nil "~{~A~%~}"
762 (format nil "~S" "RANDOM STATE")
763 (format nil "~S" (clnl-random:export))
765 (format nil "~S" "GLOBALS")
767 "\"min-pxcor\",\"max-pxcor\",\"min-pycor\",\"max-pycor\",\"perspective\",\"subject\","
768 "\"nextIndex\",\"directed-links\",\"ticks\",")
769 (format nil "\"~A\",\"~A\",\"~A\",\"~A\",\"0\",\"nobody\",\"~A\",\"\"\"NEITHER\"\"\",\"-1\""
770 (min-pxcor) (max-pxcor) (min-pycor) (max-pycor) *current-id*)
772 (format nil "~{~A~^~%~}" (export-turtles))
774 (format nil "~{~A~^~%~}" (export-patches))
776 (format nil "~S" "LINKS")
777 "\"end1\",\"end2\",\"color\",\"label\",\"label-color\",\"hidden?\",\"breed\",\"thickness\",\"shape\",\"tie-mode\""