Detailed Description

Represents a stateless m-to-n function.

Author: Sylvain Hallé

Since: 0.2.1

Definition at line 38 of file Function.java.

Public Member Functions
void	evaluate (Object[] inputs, Object[] outputs, Context context)
	Evaluates the outputs of the function, given some inputs.
abstract void	evaluate (Object[] inputs, Object[] outputs, Context context, EventTracker tracker)
	Evaluates the outputs of the function, given some inputs.
void	evaluate (Object[] inputs, Object[] outputs)
	Evaluates the outputs of the function, given some inputs.
boolean	evaluatePartial (Object[] inputs, Object[] outputs, Context context)
	Evaluates the outputs of the function, given some inputs.
boolean	evaluateLazy (Object[] inputs, Object[] outputs)
	Attempts a lazy evaluation of the function, given some inputs.
abstract int	getInputArity ()
	Gets the function's input arity, i.e.
abstract int	getOutputArity ()
	Gets the function's output arity, i.e.
void	reset ()
	Resets the function to its initial state.
abstract void	getInputTypesFor (Set< Class<?> > classes, int index)
	Populates the set of classes accepted by the function for its i-th input.
abstract Class<?>	getOutputTypeFor (int index)
	Returns the type of the events produced by the function for its i-th output.
final Function	duplicate ()
	Duplicates an object and sets it to its initial state.
abstract Function	duplicate (boolean with_state)
	Duplicates an object.
Object	print (ObjectPrinter<?> printer)
final Function	read (ObjectReader<?> reader, Object o) throws FunctionException
	Reads the content of a function from a serialized object.

Static Public Attributes
static final int	s_maxInputArity = 10
	The maximum input arity that a function can have.

Protected Member Functions
Object	printState ()
	Produces an object that represents the state of the current function.
Function	readState (Object o)
	Reads the state of a function and uses it to create a new instance.

Member Function Documentation

◆ duplicate() [1/2]

final Function ca.uqac.lif.cep.functions.Function.duplicate ( )

Duplicates an object and sets it to its initial state.

This should be the same thing as calling duplicate(false).

Returns: Another object

Implements ca.uqac.lif.cep.functions.DuplicableFunction.

Definition at line 205 of file Function.java.

◆ duplicate() [2/2]

abstract Function ca.uqac.lif.cep.functions.Function.duplicate ( boolean with_state )

abstract

Duplicates an object.

Optionally, set the object into the same state as the source object.

Parameters

with_state Set to true to replicate the object's state, false to create a new copy in the initial state.

Returns: Another object

Implements ca.uqac.lif.cep.Duplicable.

◆ evaluate() [1/3]

void ca.uqac.lif.cep.functions.Function.evaluate	(	Object[]	inputs,
		Object[]	outputs )

Evaluates the outputs of the function, given some inputs.

Parameters

inputs	The arguments of the function. The size of the array should be equal to the function's declared input arity.
outputs	The outputs of the function. The size of the array should be equal to the function's declared output arity. @ Any exception that may occur during the evaluation of a function

Reimplemented in ca.uqac.lif.cep.functions.Constant, ca.uqac.lif.cep.functions.FunctionTree, ca.uqac.lif.cep.functions.IdentityFunction, ca.uqac.lif.cep.functions.PassthroughFunction, ca.uqac.lif.cep.functions.RaiseArity, and ca.uqac.lif.cep.functions.Variable.

Definition at line 99 of file Function.java.

◆ evaluate() [2/3]

void ca.uqac.lif.cep.functions.Function.evaluate	(	Object[]	inputs,
		Object[]	outputs,
		Context	context )

Evaluates the outputs of the function, given some inputs.

Parameters

inputs	The arguments of the function. The size of the array should be equal to the function's declared input arity.
outputs	The outputs of the function. The size of the array should be equal to the function's declared output arity.
context	The context in which the evaluation is done. If the function's arguments contains placeholders, they will be replaced by the corresponding object fetched from this map before evaluating the function

Definition at line 60 of file Function.java.

◆ evaluate() [3/3]

abstract void ca.uqac.lif.cep.functions.Function.evaluate	(	Object[]	inputs,
		Object[]	outputs,
		Context	context,
		EventTracker	tracker )

abstract

Evaluates the outputs of the function, given some inputs.

Parameters

inputs	The arguments of the function. The size of the array should be equal to the function's declared input arity.
outputs	The outputs of the function. The size of the array should be equal to the function's declared output arity.
context	The context in which the evaluation is done. If the function's arguments contains placeholders, they will be replaced by the corresponding object fetched from this map before evaluating the function
tracker	An event tracker to record associations between inputs and outputs. This argument is optional and may be null.

◆ evaluateLazy()

boolean ca.uqac.lif.cep.functions.Function.evaluateLazy	(	Object[]	inputs,
		Object[]	outputs )

Attempts a lazy evaluation of the function, given some inputs.

Parameters

inputs	The arguments of the function. The size of the array should be equal to the function's declared input arity.
outputs	The outputs of the function. The size of the array should be equal to the function's declared output arity. @ Any exception that may occur during the evaluation of a function

Returns: true if the function succeeded in producing an output value, false otherwise

Reimplemented in ca.uqac.lif.cep.functions.FunctionTree.

Definition at line 150 of file Function.java.

◆ evaluatePartial()

boolean ca.uqac.lif.cep.functions.Function.evaluatePartial	(	Object[]	inputs,
		Object[]	outputs,
		Context	context )

Evaluates the outputs of the function, given some inputs.

Parameters

inputs	The arguments of the function. The size of the array should be equal to the function's declared input arity.
outputs	The outputs of the function. The size of the array should be equal to the function's declared output arity.
context	The context in which the evaluation is done. If the function's arguments contains placeholders, they will be replaced by the corresponding object fetched from this map before evaluating the function

Returns: true if the function succeeded in producing an output value, false otherwise

Reimplemented in ca.uqac.lif.cep.functions.Constant, ca.uqac.lif.cep.functions.FunctionTree, ca.uqac.lif.cep.functions.StreamVariable, ca.uqac.lif.cep.util.Booleans.And, ca.uqac.lif.cep.util.Booleans.Implies, ca.uqac.lif.cep.util.Booleans.Or, and ca.uqac.lif.cep.util.Numbers.Multiplication.

Definition at line 122 of file Function.java.

◆ getInputArity()

abstract int ca.uqac.lif.cep.functions.Function.getInputArity ( )

abstract

Gets the function's input arity, i.e.

the number of arguments it takes.

Returns: The input arity

◆ getInputTypesFor()

abstract void ca.uqac.lif.cep.functions.Function.getInputTypesFor	(	Set< Class<?> >	classes,
		int	index )

abstract

Populates the set of classes accepted by the function for its i-th input.

Parameters

classes	The set of to fill with classes
index	The index of the input to query

◆ getOutputArity()

abstract int ca.uqac.lif.cep.functions.Function.getOutputArity ( )

abstract

Gets the function's output arity, i.e.

the number of elements it outputs. (We expect that most functions will have an output arity of 1.)

Returns: The output arity

◆ getOutputTypeFor()

abstract Class<?> ca.uqac.lif.cep.functions.Function.getOutputTypeFor ( int index )

abstract

Returns the type of the events produced by the function for its i-th output.

Parameters

index The index of the output to query

Returns: The type of the output

◆ print()

Object ca.uqac.lif.cep.functions.Function.print ( ObjectPrinter<?> printer )

Since: 0.10.2

Definition at line 217 of file Function.java.

◆ printState()

Object ca.uqac.lif.cep.functions.Function.printState ( )

protected

Produces an object that represents the state of the current function.

A concrete function should override this method to add whatever state information that needs to be preserved in the serialization process.

Returns: Any object representing the function's state (including null)

Since: 0.10.2

Reimplemented in ca.uqac.lif.cep.functions.Constant, ca.uqac.lif.cep.functions.ContextVariable, ca.uqac.lif.cep.functions.FunctionTree, ca.uqac.lif.cep.functions.IdentityFunction, ca.uqac.lif.cep.functions.RaiseArity, ca.uqac.lif.cep.functions.StreamVariable, and ca.uqac.lif.cep.util.NthElement.

Definition at line 239 of file Function.java.

◆ read()

final Function ca.uqac.lif.cep.functions.Function.read	(	ObjectReader<?>	reader,
		Object	o ) throws FunctionException

Reads the content of a function from a serialized object.

Parameters

reader	An object reader
o	The object to read from

Returns: The deserialized function

Exceptions

FunctionException If the read operation failed for some reason

Definition at line 253 of file Function.java.

◆ readState()

Function ca.uqac.lif.cep.functions.Function.readState ( Object o )

protected

Reads the state of a function and uses it to create a new instance.

Parameters

o	The object containing the function's state

Returns: A new function instance

Since: 0.10.2

Reimplemented in ca.uqac.lif.cep.functions.Constant, ca.uqac.lif.cep.functions.ContextVariable, ca.uqac.lif.cep.functions.FunctionTree, ca.uqac.lif.cep.functions.IdentityFunction, ca.uqac.lif.cep.functions.IfThenElse, ca.uqac.lif.cep.functions.RaiseArity, ca.uqac.lif.cep.functions.StreamVariable, and ca.uqac.lif.cep.util.NthElement.

Definition at line 290 of file Function.java.

◆ reset()

void ca.uqac.lif.cep.functions.Function.reset ( )

Resets the function to its initial state.

In the case of a stateless function, nothing requires to be done.

Reimplemented in ca.uqac.lif.cep.functions.BinaryFunction< T, V, U >, ca.uqac.lif.cep.functions.Constant, ca.uqac.lif.cep.functions.FunctionTree, ca.uqac.lif.cep.functions.IdentityFunction, ca.uqac.lif.cep.functions.IfThenElse, ca.uqac.lif.cep.functions.PassthroughFunction, ca.uqac.lif.cep.functions.UnaryFunction< T, U >, ca.uqac.lif.cep.functions.Variable, and ca.uqac.lif.cep.util.Bags.ToCollection.

Definition at line 177 of file Function.java.

Member Data Documentation

◆ s_maxInputArity

final int ca.uqac.lif.cep.functions.Function.s_maxInputArity = 10

static

The maximum input arity that a function can have.

Definition at line 43 of file Function.java.

The documentation for this class was generated from the following file:

/home/sylvain/Workspaces/beepbeep/core/src/ca/uqac/lif/cep/functions/Function.java

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Member Function Documentation

◆ duplicate() [1/2]

◆ duplicate() [2/2]

◆ evaluate() [1/3]

◆ evaluate() [2/3]

◆ evaluate() [3/3]

◆ evaluateLazy()

◆ evaluatePartial()

◆ getInputArity()

◆ getInputTypesFor()

◆ getOutputArity()

◆ getOutputTypeFor()

◆ print()

◆ printState()

◆ read()

◆ readState()

◆ reset()

Member Data Documentation

◆ s_maxInputArity