Object Popcorn.Dictionary.Dict

object Popcorn.Dictionary.Dict

A base dictionary object provides common generators for array dictionaries.

Defined in Popcorn.Dictionary

Function Summary

generator element(random rand)

'element' returns one random dictionary element.

generator elements(integer n, random rand)

'elements' returns n random dictionary element.

generator list()

generator list(integer n)

generator list(integer n, integer m)

Creates a generator to list dictionary elements.

Function Details

function element

generator element(random rand)

'element' returns one random dictionary element. This generator uses a random generator 'rand' if provided, otherwise creates a new Popcorn.Core.random generator.

Parameters:

rand - a random generator 'random()'.

function elements

generator elements(integer n, random rand)

'elements' returns n random dictionary element.

Parameters:

n - element count to generate

rand - optional a random generator 'random()'.

function list

generator list()

generator list(integer n)

generator list(integer n, integer m)

Creates a generator to list dictionary elements. By default all dictionary elements are listed. If 'n' > dict.length the resulting elements are repeated in loop. 'list' is a range function that takes no arguments, or one or two integer arguments.

Parameters:

No arguments - the generator returns the entire dictionary.

One int argument - the generator returns the first n elements.

n - element count.

two int arguments - the generator returns elements from n to m

n - from list index

m - to list index