Namespace Popcorn

namespace Popcorn

Root Popcorn namespace.

Authors:

Adam Smyczek

Function Interface Summary

any combinator(any r, any n)

A combinator function is used by Popcorn.Core.seq and Popcorn.Core.replicate to accumulate results of subsequent generator executions.

any generator(any input)

A generator is a function that takes one argument and returns an object of the form:


   {
     result: value,
     state : state_obj
   }

'result' is the evaluation result of the generator.

Function Interface Details

ifunction combinator

any combinator(any r, any n)

A combinator function is used by Popcorn.Core.seq and Popcorn.Core.replicate to accumulate results of subsequent generator executions.

Parameters:

r - the combined result from previous executions or the initial value on first call.

n - the result of the current generator execution.

Returns:

the new accumulated result.

ifunction generator

any generator(any input)

A generator is a function that takes one argument and returns an object of the form:


   {
     result: value,
     state : state_obj
   }

'result' is the evaluation result of the generator. A state object is passed to the generation process and can be manipulated by any generator. See Popcorn.Core.generate for details. Popcorn provides functions to create and combine generators to build any kind of data. See README for more information.

Parameters:

input - any variable, object, etc.

Defined in project.js