FoldLeft (Apache Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.functor.core.algorithm.FoldLeft<T>

Type Parameters:
T - the returned evaluation type.

All Implemented Interfaces:

BinaryFunction<Generator<T>,T,T>, BinaryFunctor<Generator<T>,T>, Function<Generator<T>,T>, Functor, UnaryFunctor<Generator<T>>
```
public class FoldLeft<T>
extends Object
implements Function<Generator<T>,T>, BinaryFunction<Generator<T>,T,T>
```
Functional left-fold algorithm against the elements of a Generator. Uses the seed object (if supplied) as the initial left-side argument to the BinaryFunction, then uses the result of that evaluation as the next left-side argument, until the Generator's elements have been expended.

Version:

$Revision: 1537906 $ $Date: 2013-11-01 12:47:33 +0100 (Fr, 01 Nov 2013) $

Constructor Summary

Constructors
Constructor and Description

FoldLeft(BinaryFunction<? super T,? super T,? extends T> func)
Create a new FoldLeft.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`T`	`evaluate(Generator<T> obj)` Evaluate this function.
`T`	`evaluate(Generator<T> left, T right)` Evaluate this function.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FoldLeft
```
public FoldLeft(BinaryFunction<? super T,? super T,? extends T> func)
```
    Create a new FoldLeft.
    
    Parameters:
    func - BinaryFunction to apply to each (seed, next)
- Method Detail
  - evaluate
```
public final T evaluate(Generator<T> obj)
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface Function<Generator<T>,T>
    
    Parameters:
    obj - Generator to transform
    
    Returns:
    the T result of this evaluation
  - evaluate
```
public final T evaluate(Generator<T> left,
         T right)
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface BinaryFunction<Generator<T>,T,T>
    
    Parameters:
    left - Generator to transform
    right - initial left-side seed object
    
    Returns:
    the T result of this function for the given arguments
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.