org.oakgp.function.hof

Class Map

java.lang.Object

org.oakgp.function.hof.Map

All Implemented Interfaces:

Function

public final class Map
extends Object
implements Function

Returns the result of applying a function to each element of a collection.

Returns a new collection that exists of the result of applying the function (specified by the first argument) to each element of the collection (specified by the second argument).

See Also:

Wikipedia

Constructor Summary

Constructors

Constructor and Description
Map(Type from, Type to) Creates a higher order functions that applies a function to each element of a collection.

Method Summary

Modifier and Type	Method and Description
Object	evaluate(Arguments arguments, Assignments assignments) Returns the result of applying this operation to the specified Arguments and Assignments.
Signature	getSignature() Returns the return type and argument types associated with this function.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oakgp.function.Function

getDisplayName, isPure, simplify

Constructor Detail

Map

public Map(Type from,
           Type to)

Creates a higher order functions that applies a function to each element of a collection.

Parameters:

from - the type of the elements contained in the collection provided as an argument to the function

to - the type of the elements contained in the collection returned by the function

Method Detail

evaluate

public Object evaluate(Arguments arguments,
                       Assignments assignments)

Description copied from interface: Function

Returns the result of applying this operation to the specified Arguments and Assignments.

Specified by:

evaluate in interface Function

Parameters:

arguments - represents the arguments to apply to the operation

assignments - represents values assigned to variables belonging to arguments

Returns:

the result of applying this operation to the arguments and assignments

getSignature

public Signature getSignature()

Description copied from interface: Function

Returns the return type and argument types associated with this function.

Specified by:

getSignature in interface Function