Clarify HW03 text (#19)

Author: nmheim

docs/Manifest.toml

@@ -57,9 +57,9 @@ version = "1.16.1+0"
 
 [[ChainRulesCore]]
 deps = ["Compat", "LinearAlgebra", "SparseArrays"]
-git-tree-sha1 = "a325370b9dd0e6bf5656a6f1a7ae80755f8ccc46"
+git-tree-sha1 = "8d954297bc51cc64f15937c2093799c3617b73e4"
 uuid = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
-version = "1.7.2"
+version = "1.10.0"
 
 [[ColorSchemes]]
 deps = ["ColorTypes", "Colors", "FixedPointNumbers", "Random"]
@@ -131,9 +131,9 @@ version = "0.8.5"
 
 [[Documenter]]
 deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
-git-tree-sha1 = "8b43e37cfb4f4edc2b6180409acc0cebce7fede8"
+git-tree-sha1 = "769275a95354ef52e5f4b00814249da73d53869e"
 uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-version = "0.27.7"
+version = "0.27.9"
 
 [[DocumenterTools]]
 deps = ["AbstractTrees", "Base64", "DocStringExtensions", "Documenter", "FileWatching", "Gumbo", "LibGit2", "Sass"]
@@ -218,9 +218,9 @@ version = "3.3.5+0"
 
 [[GR]]
 deps = ["Base64", "DelimitedFiles", "GR_jll", "HTTP", "JSON", "Libdl", "LinearAlgebra", "Pkg", "Printf", "Random", "Serialization", "Sockets", "Test", "UUIDs"]
-git-tree-sha1 = "c2178cfbc0a5a552e16d097fae508f2024de61a3"
+git-tree-sha1 = "d189c6d2004f63fd3c91748c458b09f26de0efaa"
 uuid = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71"
-version = "0.59.0"
+version = "0.61.0"
 
 [[GR_jll]]
 deps = ["Artifacts", "Bzip2_jll", "Cairo_jll", "FFMPEG_jll", "Fontconfig_jll", "GLFW_jll", "JLLWrappers", "JpegTurbo_jll", "Libdl", "Libtiff_jll", "Pixman_jll", "Pkg", "Qt5Base_jll", "Zlib_jll", "libpng_jll"]
@@ -321,9 +321,9 @@ uuid = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
 version = "0.13.4"
 
 [[IrrationalConstants]]
-git-tree-sha1 = "f76424439413893a832026ca355fe273e93bce94"
+git-tree-sha1 = "7fd44fd4ff43fc60815f8e764c0f352b83c49151"
 uuid = "92d709cd-6900-40b7-9082-c6be49f344b6"
-version = "0.1.0"
+version = "0.1.1"
 
 [[IterTools]]
 git-tree-sha1 = "05110a2ab1fc5f932622ffea2a003221f4782c18"
@@ -550,9 +550,9 @@ version = "8.44.0+0"
 
 [[Parsers]]
 deps = ["Dates"]
-git-tree-sha1 = "a8709b968a1ea6abc2dc1967cb1db6ac9a00dfb6"
+git-tree-sha1 = "98f59ff3639b3d9485a03a72f3ab35bab9465720"
 uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
-version = "2.0.5"
+version = "2.0.6"
 
 [[Pixman_jll]]
 deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
@@ -578,9 +578,9 @@ version = "1.0.15"
 
 [[Plots]]
 deps = ["Base64", "Contour", "Dates", "Downloads", "FFMPEG", "FixedPointNumbers", "GR", "GeometryBasics", "JSON", "Latexify", "LinearAlgebra", "Measures", "NaNMath", "PlotThemes", "PlotUtils", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "Requires", "Scratch", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs"]
-git-tree-sha1 = "6841db754bd01a91d281370d9a0f8787e220ae08"
+git-tree-sha1 = "ba43b248a1f04a9667ca4a9f782321d9211aa68e"
 uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
-version = "1.22.4"
+version = "1.22.6"
 
 [[Preferences]]
 deps = ["TOML"]
@@ -708,9 +708,9 @@ version = "1.0.0"
 
 [[StatsBase]]
 deps = ["DataAPI", "DataStructures", "LinearAlgebra", "LogExpFunctions", "Missings", "Printf", "Random", "SortingAlgorithms", "SparseArrays", "Statistics", "StatsAPI"]
-git-tree-sha1 = "65fb73045d0e9aaa39ea9a29a5e7506d9ef6511f"
+git-tree-sha1 = "eb35dcc66558b2dda84079b9a1be17557d32091a"
 uuid = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
-version = "0.33.11"
+version = "0.33.12"
 
 [[StructArrays]]
 deps = ["Adapt", "DataAPI", "StaticArrays", "Tables"]

docs/src/lecture_03/hw.md

@@ -30,13 +30,17 @@ in your code will cause the automatic evaluation to fail.
 Implement a new species `Mushroom` which tricks a sheep into eating it by its
 delicious looks but decreases the energy of the sheep by
 `size(::Mushroom)*Δenergy(::Sheep)`.
+
+**Note**: The auto-eval system assumes that you have a constructor
+`Mushroom(id,size,max_size)` that accepts the three plant fields as arguments
+(as implemented e.g. [here](https://github.com/JuliaTeachingCTU/EcosystemCore.jl/blob/359f0b48314f9aa3d5d8fa0c85eebf376810aca6/src/plant.jl#L11-L13)).
 ```@raw html
 </div></div>
 ```
 Your new species should give you results like below
 ```@repl hw03
 s = Sheep(1,2,1,1,1);
-m = Mushroom(2,5);
+m = Mushroom(2,2,5);
 w = World([s,m])
 eat!(s,m,w);
 w
@@ -70,20 +74,23 @@ simulation.
 <header class="admonition-header">Homework (1 point)</header>
 <div class="admonition-body">
 ```
-Implement a function `every_nth(f::Function,n::Int)` that takes a function and
-uses a closure to construct another function that only calls `f` every `n`
-calls to the function `fn` that is returned by `every_nth(f,n)`.
+Implement a function `every_nth(f::Function,n::Int)` that takes an inner
+function `f` and uses a closure to construct an outer function `g` that only
+calls `f` every `n`th call to `g`. E.g. if `n=3` the inner function `f` be called
+at the 3rd, 6th, 9th ... call to `g` (not at the 1st, 4th, 7th... call).
 
+**Hint**: You can use splatting via `...` to pass on an unknown number of
+arguments from the outer to the inner function.
 ```@raw html
 </div></div>
 ```
 You can use `every_nth` to log (or save) the agent count only every couple of
 steps of your simulation. Using `every_nth` will look like this:
 ```@repl hw03
 # `@info agent_count(w)` is executed only every 5th call to logcb(w)
-logcb = every_nth(w->(@info agent_count(w)), 5);
+logcb = every_nth(w->(@info agent_count(w)), 3);
 
-for i in 1:10
-    logcb(w)
-end
+logcb(w);  # x->(@info agent_count(w)) is not called
+logcb(w);  # x->(@info agent_count(w)) is not called
+logcb(w);  # x->(@info agent_count(w)) *is* called
 ```