Skip to content

Commit afa4d01

Browse files
committedSep 21, 2018
Consistency in heading capitalisations
1 parent 30588b4 commit afa4d01

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed
 

‎flamegpu/api.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ In addition, for each member variable defined for each vertex, and each edge a f
613613
614614
615615
616-
Sorting agents
616+
Sorting Agents
617617
--------------
618618

619619
Each `CONTINUOUS` type agent can be sorted based on key value pairs which come from agent variables. This can be particularly useful for rendering. A function for sorting each agent (named `*agent*`) state list (in the below example the state is named `default`) is created with the folowing format.
@@ -666,7 +666,7 @@ The value `xmachine_memory_agent_MAX` is the buffer size of number of agents (se
666666
cudaDeviceSynchronize();
667667
}
668668
669-
Analytics functions
669+
Analytics Functions
670670
-------------------
671671

672672
A dynamically generated *reduce* function is made for all agent variables for each state. A dynamically generated *count*, *min* and *max* functions will only be created for single-value (not array) variables. Count functions are limited to `int` type variables (including short, long and vector type variants), min and max functions are limited to non vector type variables (e.g. no dvec2 type of variables). Reduce functions sum over a particular variable variable for all agents in the state list and returns the total. Count functions check how many values are equal to the given input and returns the quantity that match. These *analytics* functions are typically used with init, step and exit functions to calculate averages or distributions of a given variable. E.g. for agent agent with a *name* of `agentName`, *state* of `default` and an `int` variable name `varName` the following analytics functions will be created.

0 commit comments

Comments
 (0)