FP

java.lang.Object
- com.flyingspaniel.nava.fp.FP

```
public class FP
extends Object
```
Static utilities for Functional Programming

Since:

Copyright (c) 2013 by Morgan Conrad

Author:

Morgan Conrad

See Also:
This software is released under the MIT License

Constructor Summary

Constructors
Constructor and Description

FP()

Constructors
Constructor and Description
`FP()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <IN> boolean`	`every(Iterable<IN> ins, Fn<IN,?> filterFn)` Check if every Object passes Fn (same as forAll())
`static <IN> boolean`	`exists(Iterable<IN> ins, Fn<IN,?> filterFn)` Check if any Object passes Fn (same as some() and Groovy's any())
`static <IN> ArrayList<IN>`	`filter(Iterable<IN> ins, Fn<IN,?> filterFn)` Filter (keep) Objects accepted by Fn to a new ArrayList.
`static <IN> IN`	`fold(IN seed, Iterable<IN> ins, Fn<IN,IN> fn)` Fold objects using a generified Fn function
`static double`	`foldp(double seed, double[] ins, Fn.Pdouble fn)` Fold doubles using a primitive double (Fn.Pdouble) function
`static int`	`foldp(int seed, int[] ins, Fn.Pint fn)` Fold ints using a primitive int (Fn.Pint) function
`static <IN> IN`	`foldRight(IN seed, List<IN> ins, Fn<IN,IN> fn)` FoldRight objects using a generified Fn function
`static double`	`foldRightp(double seed, double[] ins, Fn.Pdouble fn)` FoldRight doubles using a primitive double (Fn.Pdouble) function
`static int`	`foldRightp(int seed, int[] ins, Fn.Pint fn)` FoldRight ints using a primitive int (Fn.Pint) function
`static <IN> boolean`	`forAll(Iterable<IN> ins, Fn<IN,?> filterFn)` Check if every Object passes Fn (same as every())
`static int`	`indexOf(Object grail, Object... array)` Find index of grail in array, usually using equals()
`static int`	`indexOfByRef(Object grail, Object... array)` FInd index of grail in array, using ==
`static boolean`	`isFalse(Object o)` For a filter function (filterFn in formal arguments above) converts their output to true/false
`static boolean`	`isTrue(Object o)` For a filter function (filterFn in formal arguments above) converts their output to true/false
`static String`	`join(Iterable ins)` Default uses comma delim
`static String`	`join(Object... ins)`
`static String`	`join(String delim, Iterable ins)` Join Objects into a String.
`static <IN,OUT> ArrayList<OUT>`	`map(Iterable<IN> ins, Fn<IN,OUT> fn)` Map all Objects to a new List, transforming them via Fn
`static <IN> IN`	`reduce(Iterable<IN> ins, Fn<IN,IN> fn)` Reduce Objects using a generified Fn function
`static double`	`reducep(double[] ins, Fn.Pdouble fn)` Reduce doubles using a primitive double (Fn.Pdouble) function
`static int`	`reducep(int[] ins, Fn.Pint fn)` Reduce ints using a primitive int (Fn.Pint) function
`static <IN> boolean`	`some(Iterable<IN> ins, Fn<IN,?> fn)` Check if any Object passes Fn (same as exists())

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

- Constructor Detail
  - FP
```
public FP()
```
- Method Detail
  - fold
```
public static <IN> IN fold(IN seed,
           Iterable<IN> ins,
           Fn<IN,IN> fn)
```
    Fold objects using a generified Fn function
  - foldp
```
public static double foldp(double seed,
           double[] ins,
           Fn.Pdouble fn)
```
    Fold doubles using a primitive double (Fn.Pdouble) function
  - foldp
```
public static int foldp(int seed,
        int[] ins,
        Fn.Pint fn)
```
    Fold ints using a primitive int (Fn.Pint) function
  - foldRight
```
public static <IN> IN foldRight(IN seed,
                List<IN> ins,
                Fn<IN,IN> fn)
```
    FoldRight objects using a generified Fn function
  - foldRightp
```
public static double foldRightp(double seed,
                double[] ins,
                Fn.Pdouble fn)
```
    FoldRight doubles using a primitive double (Fn.Pdouble) function
  - foldRightp
```
public static int foldRightp(int seed,
             int[] ins,
             Fn.Pint fn)
```
    FoldRight ints using a primitive int (Fn.Pint) function
  - reduce
```
public static <IN> IN reduce(Iterable<IN> ins,
             Fn<IN,IN> fn)
```
    Reduce Objects using a generified Fn function
  - reducep
```
public static double reducep(double[] ins,
             Fn.Pdouble fn)
```
    Reduce doubles using a primitive double (Fn.Pdouble) function
  - reducep
```
public static int reducep(int[] ins,
          Fn.Pint fn)
```
    Reduce ints using a primitive int (Fn.Pint) function
  - filter
```
public static <IN> ArrayList<IN> filter(Iterable<IN> ins,
                        Fn<IN,?> filterFn)
```
    Filter (keep) Objects accepted by Fn to a new ArrayList. Shallow copy.
    
    Type Parameters:
    IN - type of Objects
    Parameters:
    ins - inputObjects
    filterFn - return null or Boolean.FALSE to eliminate Objects
    
    Returns:
    ArrayList, may be empty
  - map
```
public static <IN,OUT> ArrayList<OUT> map(Iterable<IN> ins,
                          Fn<IN,OUT> fn)
```
    Map all Objects to a new List, transforming them via Fn
    
    Type Parameters:
    IN - type of input Objects
    OUT - type of result Objects
    Parameters:
    ins - inputObjects
    fn - maps from IN to OUT
    
    Returns:
    ArrayList of OUTs, same length as ins
  - every
```
public static <IN> boolean every(Iterable<IN> ins,
                 Fn<IN,?> filterFn)
```
    Check if every Object passes Fn (same as forAll())
    
    Type Parameters:
    IN -
    Parameters:
    ins - if empty returns true
    filterFn - Return null or Boolean.FALSE to reject a value
    
    Returns:
    true if all were accepted by fn
  - exists
```
public static <IN> boolean exists(Iterable<IN> ins,
                  Fn<IN,?> filterFn)
```
    Check if any Object passes Fn (same as some() and Groovy's any())
    
    Type Parameters:
    IN -
    Parameters:
    ins - if empty returns false
    filterFn - Return null or Boolean.FALSE to reject a value
    
    Returns:
    true if all were accepted by fn
  - forAll
```
public static <IN> boolean forAll(Iterable<IN> ins,
                  Fn<IN,?> filterFn)
```
    Check if every Object passes Fn (same as every())
    
    Type Parameters:
    IN -
    Parameters:
    ins - if empty returns true
    filterFn - Return null or Boolean.FALSE to reject a value
    
    Returns:
    true if all were accepted by fn
  - indexOf
```
public static int indexOf(Object grail,
          Object... array)
```
    Find index of grail in array, usually using equals()
    
    Parameters:
    grail -
    array -
    
    Returns:
    index, or -1 if not found
  - indexOfByRef
```
public static int indexOfByRef(Object grail,
               Object... array)
```
    FInd index of grail in array, using ==
    
    Parameters:
    grail - may be null
    array -
    
    Returns:
    index, or -1 if not found
  - join
```
public static String join(String delim,
          Iterable ins)
```
    Join Objects into a String. nulls become empty Strings
    
    Parameters:
    delim - delimiter, non-null but may be ""
    ins -
    
    Returns:
  - join
```
public static String join(Iterable ins)
```
    Default uses comma delim
    
    Parameters:
    ins -
    
    Returns:
  - join
```
public static String join(Object... ins)
```
  - some
```
public static <IN> boolean some(Iterable<IN> ins,
                Fn<IN,?> fn)
```
    Check if any Object passes Fn (same as exists())
    
    Type Parameters:
    IN -
    Parameters:
    ins - if empty returns false
    fn - Return null or Boolean.FALSE to reject a value
    
    Returns:
    true if all were accepted by fn
  - isTrue
```
public static boolean isTrue(Object o)
```
    For a filter function (filterFn in formal arguments above) converts their output to true/false
    
    Parameters:
    o -
    
    Returns:
    true if o is not null and not Boolean.FALSE
  - isFalse
```
public static boolean isFalse(Object o)
```
    For a filter function (filterFn in formal arguments above) converts their output to true/false
    
    Parameters:
    o -
    
    Returns:
    true if o is null or Boolean.FALSE

Class FP

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FP

Method Detail

fold

foldp

foldp

foldRight

foldRightp

foldRightp

reduce

reducep

reducep

filter

map

every

exists

forAll

indexOf

indexOfByRef

join

join

join

some

isTrue

isFalse