This version is out of date, covering development from v9.0.0 to v9.3.0. It is maintained here only for inbound reference links from elsewhere. It is no longer actively updated.

Jump to the current version of aTbRef

Tinderbox v9 Icon

sum(group, value)

Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Group   [operators of similar scope]

 Mathematical   [other Mathematical operators]




This computes the arithmetic Number sum of every value in a group. See sum_if() for a related conditional operator.

group describes the notes to be examined and may be any group designator including a find() query. sum() omits notes for which $Searchable is false.

value can be any expression, but is typically an attribute value.

For example,

$MyNumber = sum(children,$WordCount); 

constructs the current word count of the children of the note.

See also List/Set.sum().