ca.uqac.lif.petitpoucet.function.vector

Class VectorApply

java.lang.Object

ca.uqac.lif.dag.Node

ca.uqac.lif.petitpoucet.function.AtomicFunction

ca.uqac.lif.petitpoucet.function.vector.VectorFunction

ca.uqac.lif.petitpoucet.function.vector.VectorOutputFunction

ca.uqac.lif.petitpoucet.function.vector.ParameterizedVectorFunction

ca.uqac.lif.petitpoucet.function.vector.VectorApply

All Implemented Interfaces:

Connectable, Contextualizable, ExplanationQueryable, Function, Queryable, Duplicable

public class VectorApply
extends ParameterizedVectorFunction

Applies a m:1 function to m-uples of elements at matching positions in m input vectors.

Author:

Sylvain Hallé

Nested Class Summary

Nested classes/interfaces inherited from class ca.uqac.lif.petitpoucet.function.AtomicFunction

AtomicFunction.AtomicFunctionInputPin, AtomicFunction.AtomicFunctionOutputPin

Field Summary

Fields inherited from class ca.uqac.lif.petitpoucet.function.vector.ParameterizedVectorFunction

m_function, m_lastInstances

Fields inherited from class ca.uqac.lif.petitpoucet.function.vector.VectorOutputFunction

m_lastOutputs

Fields inherited from class ca.uqac.lif.petitpoucet.function.vector.VectorFunction

m_lastInputs

Fields inherited from class ca.uqac.lif.petitpoucet.function.AtomicFunction

m_context, m_inputPins, m_outputPins

Fields inherited from class ca.uqac.lif.dag.Node

m_inputs, m_outputs

Constructor Summary

Constructors

Constructor and Description
VectorApply(Function f) Creates a new instance of the function.

Method Summary

Modifier and Type	Method and Description
VectorApply	duplicate(boolean with_state) Creates a possibly stateful copy of an object.
PartNode	getExplanation(Part part, NodeFactory factory) Produces an explanation graph for a given part, using nodes provided by a given factory.
protected java.util.List<?>	getVectorValue(java.util.List<?>... in_lists) Computes the output list based on input lists.
java.lang.String	toString()

Methods inherited from class ca.uqac.lif.petitpoucet.function.vector.ParameterizedVectorFunction

copyInto, getSubNode, reset

Methods inherited from class ca.uqac.lif.petitpoucet.function.vector.VectorOutputFunction

getOutputValue, replaceElementByOutput, replaceInputByElement

Methods inherited from class ca.uqac.lif.petitpoucet.function.vector.VectorFunction

getMinLength, getValue

Methods inherited from class ca.uqac.lif.petitpoucet.function.AtomicFunction

copyInto, duplicate, evaluate, getContext, getExplanation, getInputPin, getOutputPin, setContext

Methods inherited from class ca.uqac.lif.dag.Node

addToInput, addToOutput, copyInto, getInputArity, getInputLinks, getOutputArity, getOutputLinks, removeFromInput, removeFromOutput, setToInput, setToOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uqac.lif.dag.Connectable

addToInput, addToOutput, getInputArity, getInputLinks, getOutputArity, getOutputLinks, removeFromInput, removeFromOutput, setToInput, setToOutput

Constructor Detail

VectorApply

public VectorApply(Function f)

Creates a new instance of the function.

Parameters:

f - The function to apply on each element of the input vector

Method Detail

getVectorValue

protected java.util.List<?> getVectorValue(java.util.List<?>... in_lists)

Description copied from class: VectorOutputFunction

Computes the output list based on input lists.

Specified by:

getVectorValue in class VectorOutputFunction

Parameters:

in_lists - The input lists

Returns:

The output list

getExplanation

public PartNode getExplanation(Part part,
                               NodeFactory factory)

Description copied from interface: ExplanationQueryable

Produces an explanation graph for a given part, using nodes provided by a given factory.

Specified by:

getExplanation in interface ExplanationQueryable

Overrides:

getExplanation in class VectorOutputFunction

Parameters:

part - The part used as the starting point of the explanation

factory - The factory that provides nodes

Returns:

A node corresponding to the root of the resulting explanation graph. The root of this graph is always a PartNode with part as its part, and the callee as the subject. Other nodes may or may not be attached to this root, depending on the subject and the explanation.

duplicate

public VectorApply duplicate(boolean with_state)

Description copied from interface: Duplicable

Creates a possibly stateful copy of an object.

Specified by:

duplicate in interface Duplicable

Overrides:

duplicate in class Node

Parameters:

with_state - Set to true for a stateful copy, false otherwise

Returns:

The object's copy

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object