Commit 377aaa7f authored by twanvl's avatar twanvl

Documented 'length' function

parent 86e9a2fd
......@@ -29,7 +29,8 @@ These functions are built into the program, other [[type:function]]s can be defi
! [[type:list|Lists]] <<<
| [[fun:position]] Find the position of an element in a list.
| [[fun:number_of_items]] Find the number of items in a list.
| [[fun:length]] Return the number of items in a list.
| [[fun:number_of_items]] Return the number of items in a list.
| [[fun:sort_list]] Sort a list.
| [[fun:filter_list]] Filter a list, keeping only elements that match a predicate.
......
Function: length
--Usage--
> length(some_collection)
Returns the number of items in a list or the number of characters in a string.
Note: This function is exactly the same as [[fun:number_of_items]].
--Parameters--
! Parameter Type Description
| @input@ [[type:list]] or [[type:map]] or [[type:set]] or [[type:string]]
Object to determine the number of items of.
When it is a set, returns the number of cards.
When it is a string, returns the number of characters.
--Examples--
> length(["x", "y", "z"]) == 3
> length("pink") == 4
--See also--
| [[fun:number_of_items]] Return the number of items in a list.
......@@ -3,7 +3,9 @@ Function: number_of_items
--Usage--
> number_of_items(in: some_collection)
Returns the position of an item in a list or characters in a string.
Returns the number of items in a list or the number of characters in a string.
Note: This function is exactly the same as [[fun:length]].
--Parameters--
! Parameter Type Description
......@@ -21,3 +23,8 @@ Returns the position of an item in a list or characters in a string.
>
> # the number of red cards in the set
> number_of_items(in: set, filter: { card.color == "red" } )
--See also--
| [[fun:length]] Return the number of items in a list.
| [[fun:sort_list]] Sort a list.
| [[fun:filter_list]] Filter a list, keeping only elements that match a predicate.
......@@ -24,3 +24,8 @@ If the item is not found in the list, returns @-1@.
>
> # The position of the card in the list of red cards, ordered by name
> postion(of: card, in: set, order_by: {card.name}, filter:{card.color == "red"})
--See also--
| [[fun:length]] / [[fun:number_of_items]] Return the number of items in a list.
| [[fun:sort_list]] Sort a list.
| [[fun:filter_list]] Filter a list, keeping only elements that match a predicate.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment